# Copyright 2022-2023 Huawei Technologies Co., Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============================================================================
"""compare tools"""
from troubleshooter import log as logger

__all__ = ["NetDifferenceFinder", ]


class NetDifferenceFinder:
    valid_kwargs = {"pt_params_path", "ms_params_path", "auto_conv_ckpt", "compare_params", "fix_seed"}
    TITLE = 'The comparison results of Net'
    FIELD_NAMES = ["PyTorch out", "MindSpore out", "result of allclose", "ratio of allclose", "cosine similarity",
                   "mean & max diffs"]

    def __init__(self, *args, **kwargs):
        logger.deprecated_api_alert(
            "NetDifferenceFinder",
            "Migrate to 'msprobe', see 'https://gitee.com/ascend/mstt/tree/master/debug/accuracy_tools/msprobe'",
        )
